Service Business Rule form

Configuration Services Service Business Rules Service Business Rules view Service Business Rule form

The Service Business Rule form enables you to add and edit service business rules. Use a service business rule and a hold/permission to set up a condition that prevents an event from occurring for the target entity type. A service business rule determines the conditions under which an event type can occur for a target entity type.

An event can only occur if one of the following applies:

Adding more than 250 service business rules can impact performance.

To add or edit a service business rule:

  1. In the Rule Name field, enter a name that uniquely identifies the service business rule.

  1. From the Target Service Event Type drop-down list, select the target event type.

The drop-down list displays the event types defined at the current scope level. For more information on adding event types, see Event Type form (on page 1).

  1. From the Rule Type drop-down list, select the rule type (on page 1) that determines how a hold/permission needs to be applied to the target entity.

  2. If the selected rule type applies to a guardian or is in relation to a guardian, the Guardian drop-down list is enabled. From the Guardian drop-down list, select the guardian type for the service business rule.

The available guardian types depend on the target entity type of the event type selected in step 2. For a list of target entities and the related guardian entity types, see Target and guardian entity types.

If the target entity is the equipment that makes up a unit, select Unit Equipments.

  1. From the Hold/Permission drop-down list, select the hold/permission that controls the effect of the service business rule.

The values listed in the Hold/Permission drop-down list depend on the Rule Type selected in step 3, and the holds/permissions defined at the current scope level. For more information on adding a holds/permissions, see Hold/Permission Type form (on page 1).

  1. If you selected the Prerequisite rule type in step 3, the Prerequisite drop-down list is enabled. From the Prerequisite drop-down list, select the event that must occur or be recorded for the target entity before the event type selected in step 2 can occur or be recorded.

In the Unit Inspector, a unit with a Prerequisite rule type applied has the Holds/Permission status of PRE-REQUISITE.

  1. In the Filter Criteria area, define a filter criteria that determines the entities for which N4 enforces the service business rule. If no filter criteria exists, the service business rule affects all entities or guarded entities, if the rule type applies to a guardian.

The filter attributes available in the Filter Criteria area depend on the target entity type such as unit, booking, or vessel visit for the event type. For more information on adding filter criteria, see Creating a filter.

  1. Click Save.

Adding more than 250 service business rules can impact performance.

When you add a new service business rule or edit an existing service business rule for a permission, N4 runs a background job to apply these updates to the target entities that satisfy the filter criteria defined in step 7. These updates are saved in the database and display in the impediments fields in the Units view when you open or refresh the list view.

You can specify the frequency and batch size for the background job that applies the service business rule updates to the target entities. The refresh-units job depends on these configuration settings: INVREFRESH001 (RFRSH_FREQ), INVREFRESH002 (RFRSH_BATCH), INVREFRESH003 (RFRSH_STALE), INVREFRESH004 (RFRSH_UNIT_NUMBER), and INVREFRESH005 (RFRSH_THREAD_NUMBER).

When processing an event, N4 always checks for a service business rule for a permission. If a service business rules exists, even if it has not been applied, N4 enforces it for the target entities satisfied by the filter criteria.

For more information on editing the configuration settings in N4, see Settings view.